/*******************************************************************************
 * Copyright (c) 2000, 2018 IBM Corp. and others
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution and
 * is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following
 * Secondary Licenses when the conditions for such availability set
 * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
 * General Public License, version 2 with the GNU Classpath
 * Exception [1] and GNU General Public License, version 2 with the
 * OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] http://openjdk.java.net/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
 *******************************************************************************/

#ifndef STACKOVERFLOWCHECKSNIPPET_INCL
#define STACKOVERFLOWCHECKSNIPPET_INCL

#include "x/codegen/HelperCallSnippet.hpp"

#include <stdint.h>
#include "env/jittypes.h"

namespace TR { class CodeGenerator; }
namespace TR { class LabelSymbol; }
namespace TR { class Node; }
namespace TR { class SymbolReference; }

namespace TR {

class X86StackOverflowCheckSnippet : public TR::X86HelperCallSnippet
   {
   uintptrj_t _scratchArg;

   public:

   X86StackOverflowCheckSnippet(TR::CodeGenerator   *cg,
                                TR::Node            *node,
                                TR::LabelSymbol      *restartlab,
                                TR::LabelSymbol      *snippetlab,
                                TR::SymbolReference *helper,
                                uintptrj_t          scratchArg,
                                int32_t             stackPointerAdjustment=0)
      :_scratchArg(scratchArg), TR::X86HelperCallSnippet(cg, node, restartlab, snippetlab, helper, stackPointerAdjustment){}

   uintptrj_t getScratchArg(){ return _scratchArg; }

   virtual uint8_t *genHelperCall(uint8_t *buffer);
   virtual uint32_t getLength(int32_t estimatedSnippetStart);
   virtual void print(TR::FILE* pOutFile, TR_Debug* debug);
   };
}

#endif
